ODMessageInterface

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODMessageInterface

Superclasses
ODObject
Subclasses
none

An object of the ODMessageInterface class provides the capability of creating and sending semantic events. This class works with the ODSemanticInterface class to handle messaging between parts.

Description
When a document is opened, the session object creates a single message interface object. All parts of that document share the same message interface object; you can obtain a reference to it by calling the session object's GetMessageInterface method (page 608).
The OpenDoc message interface object is responsible for constructing Apple events, getting and setting event attributes, parsing events, and sending events. OpenDoc supports your part editor's ability to create and send semantic events through another object, the message interface, and to other parts. Your part can also send semantic events to the document shell by specifying the constant kODAppShell for the destination part. The message interface is also the object through which OpenDoc sends semantic events to your part, although your part does not make any calls to the message interface in that situation.
For more information related to semantic events, see the ODSemanticInterface class description (page 579). For more information related to creating and sending Apple events, see the "Creating and Sending Apple Events" chapter of Inside Macintosh: Interapplication Communication. For general information on scripting support in OpenDoc, see the chapter on semantic events and scripting in the OpenDoc Programmer's Guide for the MacOS.

Methods
This section presents summary descriptions of the ODMessageInterface methods grouped according to purpose, followed by detailed descriptions in alphabetical order.
Creating Events

CreateEvent
Creates an Apple event object.
CreatePartAddrDesc
Creates an address descriptor that specifies the address of the specified part.
CreatePartObjSpec
Creates an object specifier that refers to the specified part.
Sending Events

ProcessSemanticEvent
Dispatches an Apple event object to the appropriate handler.
Send
Sends the specified Apple event object and requests a reply if appropriate.

Methods
CreateEvent
CreatePartAddrDesc
CreatePartObjSpec
ProcessSemanticEvent
Send